Skip to content

codespell_lib/_codespell.py: read additional args from file with with…#3841

Merged
larsoner merged 2 commits intocodespell-project:mainfrom
julian-smith-artifex-com:main
Dec 15, 2025
Merged

codespell_lib/_codespell.py: read additional args from file with with…#3841
larsoner merged 2 commits intocodespell-project:mainfrom
julian-smith-artifex-com:main

Conversation

@julian-smith-artifex-com
Copy link
Contributor

@julian-smith-artifex-com julian-smith-artifex-com commented Nov 28, 2025 •
edited
Loading

This allows arguments to be read from a file with @PATH.

It uses https://docs.python.org/3/library/argparse.html#fromfile-prefix-chars.

I'd like this change specifically to avoid having to specify a large number of paths on the command line - when codespell reports errors, ptest dumps the entire command line which makes it difficult to find the actual codespell output.

There is currently one test failure, of codecov/patch. I don't understand what's going on here - the new function convert_arg_line_to_args() is definitely called by new test test_args_from_file().

@autofix-ci
Copy link
Contributor

autofix-ci bot commented Nov 28, 2025

Hi! I'm autofix logoautofix.ci, a bot that automatically fixes trivial issues such as code formatting in pull requests.

I would like to apply some automated changes to this pull request, but it looks like I don't have the necessary permissions to do so. To get this pull request into a mergeable state, please do one of the following two things:

  1. Allow edits by maintainers for your pull request, and then re-trigger CI (for example by pushing a new commit).
  2. Manually fix the issues identified for your pull request (see the GitHub Actions output for details on what I would like to change).

@julian-smith-artifex-com julian-smith-artifex-com marked this pull request as draft November 28, 2025 23:00
@julian-smith-artifex-com julian-smith-artifex-com marked this pull request as ready for review November 30, 2025 23:58
@julian-smith-artifex-com
Copy link
Contributor Author

julian-smith-artifex-com commented Nov 30, 2025

I'm not sure why the codecov/patch test is failing - the new test definitely ends up using the new convert_arg_line_to_args() function.

@julian-smith-artifex-com
Copy link
Contributor Author

julian-smith-artifex-com commented Dec 15, 2025

I've added an explicit call to cs_.main() to persuade code coverage that we are indeed testing the new code, so all checks now pass.

[This call duplicates what we are already doing by running a child process, which presumably is not being seen by code coverage?]

Please review.

@larsoner
Copy link
Member

larsoner commented Dec 15, 2025

Looks reasonable, thanks @julian-smith-artifex-com !

@larsoner larsoner merged commit 0399f23 into codespell-project:main Dec 15, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@larsoner larsoner Awaiting requested review from larsoner larsoner is a code owner

@peternewman peternewman Awaiting requested review from peternewman peternewman is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@julian-smith-artifex-com @larsoner